/*
 * Copyright Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags and
 * the COPYRIGHT.txt file distributed with this work.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.teiid.common.buffer;

import java.lang.ref.Reference;
import java.util.List;

import org.teiid.core.TeiidComponentException;

/**
 * Acts as a combination serializer/cachemanager
 */
public interface BatchManager {

    List<List<?>> getBatch(Long batch, boolean retain) throws TeiidComponentException;

    void remove(Long batch);

    void setPrefersMemory(boolean prefers);

    boolean prefersMemory();

    Long createManagedBatch(List<? extends List<?>> batch, Long previous, boolean removeOld) throws TeiidComponentException;

    void remove();

    Reference<? extends BatchManager> getBatchManagerReference();

    String[] getTypes();

    int getRowSizeEstimate();
}
